home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
maximus
/
lcall10.zip
/
LOGCALL.DOC
< prev
next >
Wrap
Text File
|
1992-07-26
|
9KB
|
283 lines
******************************************************************
LOGCALL Version 1.0
July 26, 1992
MAXIMUS TODAY'S CALLER LISTER
Code by Evan Siegworth
Docs by Ed Baldwin &
Evan Siegworth
USER MANUAL
Copyright (c) 1992 Evan Siegworth
*******************************************************************
THE LEGAL BUSINESS
------------------
LOGCALL operates as specified on the authors' and beta testers'
systems. Use it at your own risk. No warranty is stated or
implied. The author shall not be responsible for any damages
resulting from its' use, directly or indirectly.
LOGCALL is distributed as a Freely Available Copyrighted Program.
You may use, copy, or lose it, but I own the rights to it.
SysOps may use any compression method acceptable to them for file
storage on their respective BBS's. The author asks only that BBS
advertisements NOT be included in the archive or archive comments.
No fee may be charged for distribution.
While LOGCALL is freely available for use in non-commercial
environments, donations to the author will always be gratefully
accepted.
For information of donations, use on a commercial bbs, or info on
where to send suggestions, please read the REGIST.DOC included
in the archive.
LOGCALL will be supported in the MUFFIN Echo, any questions will be
promptly answered.
THE DISTRIBUTION ARCHIVE (LCALL10.ZIP)
---------------------------------------
This archive should contain the following files:
LOGCALL.DOC - The complete program documentation.
LOGCALL.EXE - The Executable Program.
LOGCALL.CTL - The Configuration File.
HISTORY.DOC - The program history.
README.OS2 - Information for OS/2 Users.
REGIST.DOC - Donation/Registration Information.
WHAT DOES IT DO
---------------
LOGCALL is a Maximus CBCS Today's Callers List Creation utility which
can create a list of the users whom have called today and a list of
the last few callers. It is very configurable. You set up how you
want the utility to display the information.
It creates .BBS files that can be directly displayed to the user.
INSTALLING LOGCALL
------------------
1. Edit the LOGCALL.CTL file to your systems configuration. An
explanation of this is provided in a later section.
DONT FORGET!
2. Compile the control file. This is done by entering LOGCALL /U
at a DOS prompt in the directory that you have both LOGCALL.EXE and
LOGCALL.CTL located in. This will create logcall.cfg.
3. That's about it! Test it's functionality.
CONFIGURATION FILE
------------------
The control file tries to follow standard Maximus style .CTL file.
It also uses several existing MECCA TOKENS as well as several LOGCALL
specific TOKENS. The TOKENS will be listed later.
The first section of the control file is used to generate the list of
users whom have called the system today. The second section is for
the last few callers feature. And the third is for your custom
display lines. Each section has a control header that tells the program
it is active. If it is commented out (ie %TodaysCallers) then the rest
of that section is also automatically commented out.
Every section MUST have an 'End' marker!
-(SAMPLE .CTL FILE)-
TodaysCaller
%This specifies the Todays Caller section is being used.
FileName C:\Max\Misc\Callers.bbs
%The Drive letter MUST be used, if paths are to be used!
StatLine Line
%Specifies which display line you wish to use.
Header Header
%Specifies which file header you wish to use.
End
%Ends the section
LastFewCallers
%This specifies the Last Few Callers section is being used.
%Comment out if you dont want to use this function.
FileName C:\Max\Misc\Calls.bbs
%Same as above.
Statline Line
%Tells which display line to be used. CAN be the same
%as the one above.
Header Header2
%Same as above.
NumberInList
%Sets the maximum number of callers to be listed
%in a Last Few Callers list.
End
CustomDisplayLines
%Used to set custom string lengths. The name and city fields
%will be padded with spaces to to fill the length set below.
LengthCity 15
%Sets the length of the City/State field.
LengthName 15
%Sets the lenth of the Name/Alias fields.
#Line
#(display line here...
%Allows you to create custom lines for the .BBS file to use.
%Will be explained in detail below.
#Header
#(display line here...
%Allows you to create custom headers for the .BBS file to use.
%Explained below.
End
DISPLAY LINES:
This is the unique feature of this program. You control how the
program displays its information. You put your custom display
line in the .ctl file right after its respective name. This allows
you to have several lines in the file, but only the ones specified
above will be used.
Entering the display is alot like entering a line in a MECCA file.
Straight text will be copied directly. And there are several
informational tokens that can be placed on the line, as well as
all the regular color tokens. At this time, however, background
colors and blinking are not supported.
For Example:
A display line like this:
User # 23 Evan Siegworth calling from Channelview, TX
Would be entered like this:
#(NAME
#User # [user] [name] calling from [city]
Its that simple!
You can spice it up by adding color tokens.
The Header lines are similar yet, they do not use any of the info
tokens. This is the line that is displayed at the beginning of the
file.
For Example:
<-----------------------TODAYS CALLERS------------------------>
Some important notes:
Only ONE token per bracket. [user green name city] will NOT work.
Your display line MUST be the next line after its name header.
Several display lines are included in the .ctl that came with
the program. Use them or create your own.
You can use ORACLE to test your display lines.
AVAILABLE TOKENS:
All standard MAXIMUS Colour Tokens
[START] - Logon Time
[END] - Logoff Time
[DATE] - Logon Date
[NAME] - User's Real Name
[ALIAS] - User's Handle/Alias
[CITY] - User's City/State
[BAUD] - User's Baud Rate
[TOTAL] - Total Number of Calls
[TIME] - Minutes Spent Online
[USER] - User Number
USING LOGCALL
-------------
** First, every time the .ctl file is changed, you must update
the .cfg file. Run logcall with /u as a parameter to do
this.
** Second, logcall must reside in the same directory as Max.Log.
** Add the line below to your batch file so it runs after every
caller.
LOGCALL C:\MAX\LASTUSER.BBS (or the name your system uses ie.
LASTUS01.BBS, LASTUS02.BBS)
** You should delete the today's callers list (ex: Callers.bbs)
every night. Put it in your nightly maintance.
** Next add a command to your MAXIMUS MENUS.CTL file:
(using Callers.bbs from above sample .ctl file. substitute own
name of course)
Display_File Misc\Callers Twit "Todays Callers"
** If you wish to utilize the Last Few Callers feature.
Add a [LINK] command to your WELCOME.BBS or other file that you
wish to display to the users at logon to show the last few callers.
[LINK]C:\MAX\MISC\CALLS
That should be all that you need to do, besides adding the command to
your batch file that runs your BBS to execute after EVERY caller.
CREDITS
-------
BORLAND C++ ... Copyrighted by Borland International, Inc.
ORACLE &
MAXIMUS CBCS ... Copyrighted by Scott Dudley
LOGCALL ... Copyrighted by Evan Siegworth